@interopio/office API Reference

Object for configuring the initialization of the @interopio/office library.

Properties (15)

Property Type Default Required Description
application⚓︎ string x x

Application name. If not specified, the value depends on the hosting environment. For the browser - document.title + random number (e.g., ClientList321333). In desktop - containerName + browserWindowName (e.g., Internal.ClientList).
auth⚓︎ Auth | string x x

Authentication can use one of the following flows:

  • username/password;
  • token - access tokens can be generated after successful login from the Auth Provider (e.g., Auth0);
  • gatewayToken - Gateway tokens are time limited tokens generated by the Gateway after an explicit request. To generate one, use the io.connection.authToken() method;
  • sspi - using sessionId and authentication challenge callback;
bus⚓︎ boolean x x

Enable or disable the Pub/Sub API.
contexts⚓︎ boolean | ContextsConfig x x

Enable, disable and configure the Contexts API.
customLogger⚓︎ CustomLogger x x

Pass this to override the build-in logger and handle logging on your own
excel⚓︎ boolean true x

If true, will enable the Excel API.
gateway⚓︎ GatewayConfig x x

Configurations for the io.Connect Gateway connection.
glue⚓︎ API x x

Deprecated. Use the io property instead.
identity⚓︎ { [key: string]: string | number | boolean } x x

Specify custom identity fields. Those can also override some of the system fields assigned
insights⚓︎ boolean | Settings x x

io.Insights settings for metrics, tracing and logging.
io⚓︎ API x x

Use this to initialize the @interopio/office library with an already existing API instance of the @interopio/core library. In this case, the already initialized @interopio/core library will be extended with the @interopio/office APIs. If not provided, the @interopio/office library will initialize its own instance of the @interopio/core library internally.
logger⚓︎ LogLevel | LoggerConfig x x

Defines logging levels per output target.
metrics⚓︎ boolean | MetricsConfig x x

Metrics configurations.
outlook⚓︎ boolean true x

If true, will enable the Outlook API.
word⚓︎ boolean true x

If true, will enable the Word API.